<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class MemberModel</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> MemberModel</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class provides the code for the Member page</p>
	<ul class="tags">
				<li><span class="field">version:</span> Release: @package_version@</li>
				<li><span class="field">copyright:</span> 2009 A Memory Tree</li>
				<li><span class="field">link:</span> <a href="http://my-trac.assembla.com/amemorytree/ticket/??">http://my-trac.assembla.com/amemorytree/ticket/??</a></li>
				<li><span class="field">since:</span> Class available since Release 0.1</li>
				<li><span class="field">license:</span> A</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_models---MemberModel.php.html">/models/MemberModel.php</a> (line <span class="field">21</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																<div class="method-definition">
					<img src="../media/images/Constructor.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"><a href="../default/MemberDB.html">MemberDB</a></span>&nbsp;<span class="var-name">$db</span>, <span class="var-type"><a href="../default/MemberView.html">MemberView</a></span>&nbsp;<span class="var-name">$view</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#changePassword" title="details" class="method-name">changePassword</a>
											(<span class="var-type">array[string]mixed</span>&nbsp;<span class="var-name">&$session</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$oldPass</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$newPass</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$confirmPass</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#changePasswordForm" title="details" class="method-name">changePasswordForm</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#checkPassword" title="details" class="method-name">checkPassword</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#encrypt" title="details" class="method-name">encrypt</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#isValidPassword" title="details" class="method-name">isValidPassword</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$passCode</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#loginUser" title="details" class="method-name">loginUser</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#memberOptions" title="details" class="method-name">memberOptions</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$changePasswordMessage</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#memberPage" title="details" class="method-name">memberPage</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$changePasswordMessage</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$showOptions</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#permissionLinks" title="details" class="method-name">permissionLinks</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$permissions</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#processNewPassword" title="details" class="method-name">processNewPassword</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">array[string]mixed</span>&nbsp;<span class="var-name">$passwords</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">bool</span>
										<a href="#resetSession" title="details" class="method-name">resetSession</a>
											(<span class="var-type">array[string]mixed</span>&nbsp;<span class="var-name">&$session</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#userLogin" title="details" class="method-name">userLogin</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#welcome" title="details" class="method-name">welcome</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>)
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
													<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Constructor.png" />
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">42</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create a new instance of this class</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"><a href="../default/MemberDB.html">MemberDB</a></span>&nbsp;<span class="var-name">$db</span>, <span class="var-type"><a href="../default/MemberView.html">MemberView</a></span>&nbsp;<span class="var-name">$view</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../default/MemberDB.html">MemberDB</a></span>
				<span class="var-name">$db</span>			</li>
					<li>
				<span class="var-type"><a href="../default/MemberView.html">MemberView</a></span>
				<span class="var-name">$view</span>			</li>
				</ul>
		
			
	</div>
<a name="methodchangePassword" id="changePassword"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">changePassword</span> (line <span class="line-number">152</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Change a users password</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			changePassword
		</span>
					(<span class="var-type">array[string]mixed</span>&nbsp;<span class="var-name">&$session</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$oldPass</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$newPass</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$confirmPass</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array[string]mixed</span>
				<span class="var-name">&$session</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$oldPass</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$newPass</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$confirmPass</span>			</li>
				</ul>
		
			
	</div>
<a name="methodchangePasswordForm" id="changePasswordForm"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">changePasswordForm</span> (line <span class="line-number">229</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show the change password form</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			changePasswordForm
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$message</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcheckPassword" id="checkPassword"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">checkPassword</span> (line <span class="line-number">76</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check if the password is valid for the given user id</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			checkPassword
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span>			</li>
				</ul>
		
			
	</div>
<a name="methodencrypt" id="encrypt"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">encrypt</span> (line <span class="line-number">53</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return an encrypted form of a string</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			encrypt
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$str</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisValidPassword" id="isValidPassword"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">isValidPassword</span> (line <span class="line-number">64</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check if the password was used to create the passCode</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			isValidPassword
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$passCode</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$passCode</span>			</li>
				</ul>
		
			
	</div>
<a name="methodloginUser" id="loginUser"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">loginUser</span> (line <span class="line-number">90</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Login the user</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			loginUser
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span>			</li>
				</ul>
		
			
	</div>
<a name="methodmemberOptions" id="memberOptions"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">memberOptions</span> (line <span class="line-number">196</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show the member options page</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			memberOptions
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$changePasswordMessage</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$changePasswordMessage</span>			</li>
				</ul>
		
			
	</div>
<a name="methodmemberPage" id="memberPage"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">memberPage</span> (line <span class="line-number">244</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show the member options page</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			memberPage
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$changePasswordMessage</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$showOptions</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$changePasswordMessage</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$showOptions</span>			</li>
				</ul>
		
			
	</div>
<a name="methodpermissionLinks" id="permissionLinks"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">permissionLinks</span> (line <span class="line-number">171</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert the permissions, provided as a CSV list, into a series of links</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			permissionLinks
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$permissions</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$permissions</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocessNewPassword" id="processNewPassword"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">processNewPassword</span> (line <span class="line-number">125</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Change the password of a users account</p>
<p class="description"><p>This change occurs only if the old password is correctly given, and  the new password correctly matches the duplicate confirmation password</p></p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			processNewPassword
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">array[string]mixed</span>&nbsp;<span class="var-name">$passwords</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
					<li>
				<span class="var-type">array[string]mixed</span>
				<span class="var-name">$passwords</span>			</li>
				</ul>
		
			
	</div>
<a name="methodresetSession" id="resetSession"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">resetSession</span> (line <span class="line-number">110</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reset the session variables relating to the user login back to their default values</p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			resetSession
		</span>
					(<span class="var-type">array[string]mixed</span>&nbsp;<span class="var-name">&$session</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array[string]mixed</span>
				<span class="var-name">&$session</span>			</li>
				</ul>
		
			
	</div>
<a name="methoduserLogin" id="userLogin"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">userLogin</span> (line <span class="line-number">260</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show the user login page</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			userLogin
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
				</ul>
		
			
	</div>
<a name="methodwelcome" id="welcome"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">welcome</span> (line <span class="line-number">213</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show the welcome message</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			welcome
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$userId</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$userId</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Thu, 18 Jun 2009 14:07:59 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>